FHIR IG Statistics: StructureDefinition/ICVPVaccineDetails

Resources that use this resource

Resources that this resource uses

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition ICVPVaccineDetails

Profiles: CRMI Shareable StructureDefinition, CRMI Publishable StructureDefinition

Name	Flags	Card.	Type	Description & Constraints
ICVPVaccineDetails		0..*	PreQualVaccineDetails	Elements defined in Ancestors:productID, date, issuer, clinicianName, batchNo, validityPeriod, productID ICVP - Vaccine Details Instances of this logical model can be the target of a Reference
productID	C	1..1	Coding	Vaccine Product Constraints: is-an-icvp-product-id
Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "ICVPVaccineDetails",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablestructuredefinition",
      "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablestructuredefinition"
    ]
  },
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
      "valueBoolean": true
    }
  ],
  "url": "http://smart.who.int/icvp/StructureDefinition/ICVPVaccineDetails",
  "version": "0.1.0",
  "name": "ICVPVaccineDetails",
  "title": "ICVP - Vaccine Details",
  "status": "active",
  "experimental": true,
  "date": "2025-07-15T19:22:42+00:00",
  "publisher": "WHO",
  "contact": [
    {
      "name": "WHO",
      "telecom": [
        {
          "system": "url",
          "value": "http://who.int"
        }
      ]
    }
  ],
  "description": "Vaccine Data elements for the International Certificate of Vaccination or Prophylaxis",
  "fhirVersion": "4.0.1",
  "kind": "logical",
  "abstract": false,
  "type": "http://smart.who.int/icvp/StructureDefinition/ICVPVaccineDetails",
  "baseDefinition": "http://smart.who.int/trust-phw/StructureDefinition/PreQualVaccineDetails",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.1.0"
      }
    ],
    "element": [
      {
        "id": "ICVPVaccineDetails",
        "path": "ICVPVaccineDetails",
        "short": "ICVP - Vaccine Details",
        "definition": "Vaccine Data elements for the International Certificate of Vaccination or Prophylaxis",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "must-have-issuer-or-clinician",
            "severity": "error",
            "human": "Either issuer or clinicianName must be present",
            "expression": "issuer.exists() or clinicianName.exists()",
            "source": "http://smart.who.int/trust-phw/StructureDefinition/VaccineDetails"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ICVPVaccineDetails.productID",
        "path": "ICVPVaccineDetails.productID",
        "short": "Vaccine Product",
        "definition": "Vaccine product information (note: use InventoryItem in FHIR R6)",
        "min": 1,
        "max": "1",
        "base": {
          "path": "VaccineDetails.productID",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Coding"
          }
        ],
        "constraint": [
          {
            "key": "is-a-prequal-product-id",
            "severity": "error",
            "human": "Product ID comes from the PreQual Databatase",
            "expression": "system = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs'",
            "source": "http://smart.who.int/trust-phw/StructureDefinition/PreQualVaccineDetails"
          },
          {
            "key": "is-an-icvp-product-id",
            "severity": "error",
            "human": "Product ID comes from the ICVP vaccines from the PreQual Databatase",
            "expression": "\n\nsystem = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs'\n\n",
            "source": "http://smart.who.int/icvp/StructureDefinition/ICVPVaccineDetails"
          }
        ]
      },
      {
        "id": "ICVPVaccineDetails.date",
        "path": "ICVPVaccineDetails.date",
        "short": "Date",
        "definition": "Date of vaccine",
        "min": 1,
        "max": "1",
        "base": {
          "path": "VaccineDetails.date",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "ICVPVaccineDetails.issuer",
        "path": "ICVPVaccineDetails.issuer",
        "short": "Issuing Organization",
        "definition": "Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VaccineDetails.issuer",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          }
        ]
      },
      {
        "id": "ICVPVaccineDetails.clinicianName",
        "path": "ICVPVaccineDetails.clinicianName",
        "short": "Name of supervising clinician",
        "definition": "Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VaccineDetails.clinicianName",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ICVPVaccineDetails.batchNo",
        "path": "ICVPVaccineDetails.batchNo",
        "short": "Batch No",
        "definition": "Batch No",
        "min": 1,
        "max": "1",
        "base": {
          "path": "VaccineDetails.batchNo",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ICVPVaccineDetails.validityPeriod",
        "path": "ICVPVaccineDetails.validityPeriod",
        "short": "Certificate validity period",
        "definition": "Certificate validity period",
        "min": 0,
        "max": "1",
        "base": {
          "path": "VaccineDetails.validityPeriod",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Period"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "ICVPVaccineDetails",
        "path": "ICVPVaccineDetails",
        "short": "ICVP - Vaccine Details",
        "definition": "Vaccine Data elements for the International Certificate of Vaccination or Prophylaxis"
      },
      {
        "id": "ICVPVaccineDetails.productID",
        "path": "ICVPVaccineDetails.productID",
        "constraint": [
          {
            "key": "is-an-icvp-product-id",
            "severity": "error",
            "human": "Product ID comes from the ICVP vaccines from the PreQual Databatase",
            "expression": "\n\nsystem = 'http://smart.who.int/pcmt-vaxprequal/CodeSystem/PreQualProductIDs'\n\n",
            "source": "http://smart.who.int/icvp/StructureDefinition/ICVPVaccineDetails"
          }
        ]
      }
    ]
  }
}